//=============================================================================
//===	Copyright (C) 2001-2007 Food and Agriculture Organization of the
//===	United Nations (FAO-UN), United Nations World Food Programme (WFP)
//===	and United Nations Environment Programme (UNEP)
//===
//===	This program is free software; you can redistribute it and/or modify
//===	it under the terms of the GNU General Public License as published by
//===	the Free Software Foundation; either version 2 of the License, or (at
//===	your option) any later version.
//===
//===	This program is distributed in the hope that it will be useful, but
//===	WITHOUT ANY WARRANTY; without even the implied warranty of
//===	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//===	General Public License for more details.
//===
//===	You should have received a copy of the GNU General Public License
//===	along with this program; if not, write to the Free Software
//===	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
//===
//===	Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
//===	Rome - Italy. email: geonetwork@osgeo.org
//==============================================================================

package org.fao.oaipmh.requests;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.fao.geonet.util.ISODate;
import org.fao.oaipmh.exceptions.OaiPmhException;
import org.fao.oaipmh.responses.ListRecordsResponse;
import org.jdom.JDOMException;
import org.xml.sax.SAXException;

//=============================================================================

public class ListRecordsRequest extends ListRequest
{
	public static final String VERB = "ListRecords";

	//---------------------------------------------------------------------------
	//---
	//--- API methods
	//---
	//---------------------------------------------------------------------------

	public ISODate getFrom()  { return from;  }
	public ISODate getUntil() { return until; }

	public String getMetadataPrefix() { return mdPrefix; }
	public String getSet()            { return set;      }

	//---------------------------------------------------------------------------

	public void setFrom(ISODate date)
	{
		from = date;
	}

	//---------------------------------------------------------------------------

	public void setUntil(ISODate date)
	{
		until = date;
	}

	//---------------------------------------------------------------------------

	public void setMetadataPrefix(String mdPrefix)
	{
		this.mdPrefix = mdPrefix;
	}

	//---------------------------------------------------------------------------

	public void setSet(String set)
	{
		this.set = set;
	}

	//---------------------------------------------------------------------------

	public ListRecordsResponse execute() throws IOException, OaiPmhException, JDOMException,
															  SAXException, Exception
	{
		Map<String, String> params = new HashMap<String, String>();

		if (resumpToken != null)
			params.put("resumptionToken", resumpToken);
		else
		{
			params.put("metadataPrefix", mdPrefix);

			if (from != null)
				params.put("from", from.toString() +"Z");

			if (until != null)
				params.put("until", until.toString() +"Z");

			if (set != null)
				params.put("set", set);
		}

		return new ListRecordsResponse(this, sendRequest(params));
	}

	//---------------------------------------------------------------------------

	public String getVerb() { return VERB; }

	//---------------------------------------------------------------------------
	//---
	//--- Variables
	//---
	//---------------------------------------------------------------------------

	private ISODate from;
	private ISODate until;
	private String  mdPrefix;
	private String  set;
}

//=============================================================================

